home *** CD-ROM | disk | FTP | other *** search
/ Mac Power 1997 January / macpower199701.bin / AMUG / Utilities_48 / TouchMe 1.1.1.sit / touchMe 1.11 Folder / CW9 PP source / source / touchMeReadme.cp < prev    next >
Encoding:
Text File  |  1996-08-08  |  6.8 KB  |  169 lines
  1. // ==================================================
  2. //    touchMeReadme.cp
  3. //    Copyright (C) 1996 Mizutori Tetsuya, July 4 1996, August 4, 1996.
  4. // ==================================================
  5. //    All documents are pretty-printed in Geneva 10-point font.
  6.  
  7. #ifdef COMMENT
  8.  
  9. // --------------------------------------------------
  10. //    CTouchMe Program Roadmap
  11. // --------------------------------------------------
  12.  
  13. Global Variables:
  14.     CTouchMePref    *gPref        - class object
  15.     CTouchMeDialog    *gDialog        - class object
  16.     LHelpMenu        *gHelpMenu    - the Help Menu
  17.  
  18. // --------------------------------------------------
  19.  
  20. CTouchMeApp
  21.  * superclass: LDocApplication
  22.  * function:
  23.     +ObeyCommand()    - Save settings data to preferences file if 'OK' button is selected
  24.     +StartUp()        - Execute once when launched by Finder's OpenApplication event
  25.     +OpenDocument()    - Execute every time whenever OpenDocument AppleEvent is sent
  26.                     - Do touch command, or fill date time stamp field if option-key is pressed
  27.     +UseIdleTime()        - Reset the status every time when a series of execution has finished
  28.     +UpdateMenus()        - Extra updates for Help Menu items
  29.     +ShowAboutBox()    - Override the procedure to make a patch for colored alert dialog
  30.     +HandleAppleEvent()    - My handling AppleEvent calls for HandleXXX() functions
  31.     HandleGetPrefs()    - For responding AppleScript command 'get prefs'
  32.     HandleSetPrefs()    - For responding AppleScript command 'set prefs'
  33.     HandleLoadPrefs()    - For responding AppleScript command 'load prefs'
  34.     HandleSavePrefs()    - For responding AppleScript command 'save prefs'
  35.     HandleTouch()        - For responding AppleScript command 'touch'
  36.     HandleFetch()        - For responding AppleScript command 'fetch'
  37.  * variable:
  38.     mOpenApplication    - true if launched by the OpenApplication AppleEvent
  39.     mOpenDocument        - true if invoked by the OpenDocument AppleEvent
  40.     mKeyModifier        - Check the modifier key pressed on "Open..." ing command
  41.     mCountDoc            - Counter for execution times in the series of document files,
  42.                     - About resetting 'mCountDoc', see UseIdleTime() function above
  43.  * resource:
  44.     TouchMeAppleEvents.r    
  45.                     - Resource definition for AppleEvent 'aedt' and 'aete'
  46.  
  47. // --------------------------------------------------
  48.  
  49. CTouchMePref
  50.  * superclass: LPrefsFile
  51.  * function:
  52.     LoadPrefData()        - Read the current settings data from preferences file
  53.     SavePrefData()        - Write the current settings data to preferences file
  54.     SetXXX(*)            - Set a member 'XXX' of settings data to some status
  55.     GetXXX()            - Get the status of the member 'XXX' of settings data
  56.  * variable:
  57.     mXXX                - Each status of the member 'XXX' of settings data
  58.     mPrefRec            - A working data structure for handling preferences file
  59.  
  60. // --------------------------------------------------
  61.  
  62. CTouchMeDialog
  63.  * superclass: LDialogBox, LBroadcaster, LDragAndDrop
  64.  * function:
  65.      GetGlobalFrameRect()    - Get the global frame rect, a bound of dialog
  66.      MoveDialog(pref)    - Move the dialog window
  67.     SetupDialog(pref)    - Setup dialog status according to the 'pref' data
  68.     InspectDialog(pref)    - Set the 'pref' data according to the dialog status
  69.     Indicator(*)        - Show an indiactor whether the modifier key is pressed
  70.  
  71.      +ListenToMessage()    - Control the synchronous RadioButton changes
  72.                      - Control the 'Current Date Time Now!' button, and others
  73.     +FinishCreateSelf()    - Add listeners of RadioButtons to broadcaster of LStdCheckBox
  74.                     - // Add listeners of CDateEditFields to broadcaster of CDateEditFields
  75.     +DrawSelf()        - Draw my additional figures in the dialog window
  76.     +AttemptClose()        - Quit program like as "Cancel" button if "Close Box" was selected
  77.     +ItemIsAcceptable()    - Drag&Drop; accept files or folders dropped from Finder
  78.     +ReceiveDragItem()    - Drag&Drop; retrieve the FSSpec from the dropped object
  79.                     - Set the date time stamp fields according to the accepted file
  80.                     - Or do touch command if option-key is pressed
  81.     +EnterDropArea()    - Drag&Drop; execute once if entered into the area
  82.     +LeaveDropArea()    - Drag&Drop; execute once if left from the area
  83.     +InsideDropArea()    - Drag&Drop; execute while staying in the area
  84.     +HiliteDropArea()    - Drag&Drop; assign my custum hilite region of EditFields
  85.  * variable:
  86.  
  87.  
  88. // --------------------------------------------------
  89. //    Common Utilities
  90. // --------------------------------------------------
  91.  
  92. CDateEditField
  93.  * superclass: LEditField, LListener, LBroadcaster
  94.  * function:
  95.     +ListenToMessage()    - // Do nothing here
  96.     +UserChangedText()    - Set 'mHasChanged' to true if text has been changed
  97.     +ClickSelf()        - // Do nothing here
  98.     +BeTarget()        - // Do nothing here
  99.     +DontBeTarget()    - Call RefreshEditField() once after this EditField becomes no target
  100.     GetTEActive()        - Test the active status of TextEdit
  101.     SetTEActive(*)        - Set the active status of TextEdit
  102.     GetSelect(*)        - Get the selection of TextEdit
  103.     SetSelect(*)        - Set the selection of TextEdit
  104.     GetText(*)            - Read text string from this EditField
  105.     SetText(*)            - Write text string to this EditField
  106.     SetTextAndRefresh(*)    - Write text string, and then refresh it
  107.     SetDateTime(*)        - Convert date time seconds to string, and write it
  108.     RefreshEditField()    - Refresh the EditField if this text has been changed
  109.  * variable:
  110.     mHasChanged        - true if text has been changed by user's action
  111.  
  112. // --------------------------------------------------
  113.  
  114. CRadioButton
  115.  * superclass: LStdRadioButton
  116.  * function:
  117.     +ListenToMessage()    - Listen to CheckBox and change its Enable/Disable status
  118.  
  119. // --------------------------------------------------
  120.  
  121. LPrefsFile
  122.  * superclass: LPreferencesFile
  123.      Constructor(name)    - Create a FSSpec for the preferences file in the Preferences folder
  124.  * function:
  125.     LoadPref(*)        - Read a block data from the preferences file
  126.     SavePref(*)        - Write a block data to the preferences file
  127.  
  128. // --------------------------------------------------
  129.  
  130. UDateTime
  131.  * superclass: none
  132.  * function:
  133.     SecondsToDateTimeString(*)
  134.     DateTimeStringToSeconds(*)
  135.                     - Convert date time data in 32-bit-lengh seconds to/from string
  136.  
  137. // --------------------------------------------------
  138.  
  139. UFileInfo
  140.  * superclass: none
  141.  * function:
  142.      GetFSSpecDateTime()    - Get the creation/modification date time of the given FSSpec
  143.      SetFSSpecDateTime()    - Set the creation/modification date time of the given FSSpec
  144.      --
  145.     GetSpecType(*)        - Get the type of the given file; plain file, folder, or volume
  146.     TouchDir(*)        - Flush the volume cache to reflect the changes immediately
  147.  
  148. // --------------------------------------------------
  149.  
  150. LHelpMenu
  151.  * superclass: LMenu
  152.  * function:
  153.      LHelpMenu()        - Create LMenu for the Help Menu
  154.      InstallMenu(*)        - Add this LHelpMenu to the link table of the current MenuBar
  155.      EnableItem()        - Update the menu status to be enabled
  156.  
  157. // --------------------------------------------------
  158.  
  159. UErrorMessage
  160.  * superclass: none
  161.  * function:
  162.      NofityIfOSErr(*)    - Notify error message using Alert/Stop dialog
  163.  * resource:
  164.     ErrorMessage.r        - Resource definition for error messages and alert dialog
  165.  
  166. // --------------------------------------------------
  167.  
  168. #endif // COMMENT
  169.